Schema Changes from V11.0 through V11.4

The V11.x schema include all functionality available in V10.x, as well as several features/capabilities added to V9.x, but not V10.x (e.g., ideal and giropay).

For all 11.x family of schema, the id attribute is required. Linked transactions (i.e., transactions that use the litleTxnId to reference the parent transaction) no longer return a response code of 001 - Transaction Received in the XML response message, as they did in V10.x. You receive either a 000 - Approved or a decline code, but you must still either pick up the Declined Transaction SSR report, or view the Declined transaction report in the eComm iQ to determine the final disposition of the approved transactions.

The table below includes elements added in schema version 11.0.

TABLE 1-9 New Elements in V11.0 through V11.4

New Element

Parent of

Child of

Comments

giftCardAuthReversal

 

 

 

 

 

card

originalRefCode

originalAmount

originalTxnTime

originalSystemTraceId

originalSequenceNumber

litleTxnId

litleOnlineRequest

batchRequest

 

 

 

 

 

Used for Gift Card Auth Reversals

 

 

 

 

 

originalRefCode

 

 

 

 

 

 

activateReversal

deactivateReversal

depositReversal

giftCardAuthReversa l

giftCardCapture

loadReversal

refundReversal

unloadReversal

Used to link reversal or capture transaction to original Gift Card transaction.

 

 

 

 

 

originalAmount

 

 

 

 

 

 

activateReversal

deactivateReversal

depositReversal

giftCardAuthReversa l

giftCardCapture

loadReversal

refundReversal

unloadReversal

Used to link reversal or capture transaction to original Gift Card transaction.

 

 

 

 

 

originalTxnTime

 

 

 

 

 

 

activateReversal

deactivateReversal

depositReversal

giftCardAuthReversal

giftCardCapture

loadReversal

refundReversal

unloadReversal

Used to link reversal or capture transaction to original Gift Card transaction.

 

 

 

 

 

originalSystemTraceId

 

 

 

 

 

activateReversal

deactivateReversal

depositReversal

giftCardAuthReversal

loadReversal

refundReversal

unloadReversal

Used to link reversal transaction to original Gift Card transaction.

 

 

 

 

originalSequenceNumber

 

 

 

 

 

activateReversal

deactivateReversal

depositReversal

giftCardAuthReversal

loadReversal

refundReversal

unloadReversal

Used to link reversal or capture transaction to original Gift Card transaction.

 

 

 

 

giftCardAuthReveralResponse

 

 

 

litleTxnId

response

responseTime

message

giftCardResponse

postDate

litleOnlineResponse

batchResponse

 

 

 

Response to a giftCardAuthRevers al transaction.

 

 

 

giftCardCapture

 

 

 

 

card

captureAmount

originalRefCode

originalAmount

originalTxnTime

litleTxnId

litleOnlineRequest

batchRequest

 

 

 

 

Used for Gift Card Captures

 

 

 

 

captureAmount

 

giftCardCapture

Specifies the amount to capture.

giftCardCaptureResponse

 

 

 

 

litleTxnId

response

responseTime

message

giftCardResponse

postDate

fraudResult

litleOnlineResponse

batchResponse

 

 

 

 

Response to a giftCardCapture transaction.

 

 

 

 

giftCardCredit

 

 

 

card

creditAmount

litleTxnId

orderSource

orderId

litleOnlineRequest

batchRequest

 

 

 

Used for Gift Card Credits

 

 

 

captureredit

 

giftCardCredit

Specifies the amount to credit.

giftCardCreditResponse

 

 

 

 

litleTxnId

response

responseTime

message

giftCardResponse

postDate

fraudResult

litleOnlineResponse

batchResponse

 

 

 

 

Response to a giftCardCredit transaction.

 

 

 

 

giftCardResponse

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

availableBalance

refCode

systemTraceId

sequenceNumber

beginningBalance

endingBalance

cashBackAmount

Note: Although shown in

the schema, beginningBalance,

endingBalance, and cashBackAmount are not currently supported.

 

 

 

 

 

activateResponse

deactivateResponse

autorizationResponse

giftCardAuthReversalResponse

balanceInquiryResponse

captureGivenAuthResponse

giftCardCaptureResponse

giftCardCreditResponse

deactivateResponse

deactivateReversalResponse

depositReversalResponse

forceCaptureResponse

loadResponse

loadReversalResponse

refundReversalResponse

saleResponse

unloadResponse

unloadReversalResponse

Provides details about

the beginning, ending,

and available balance on

a Gift Card, as well as

the cash back amount, if applicable.

Note: This element already existed in the schema. In this release, refCode, systemTraceId, and sequenceNumber were added.

 

 

 

 

 

 

refCode

 

giftCardResponse

Specifies the authorization code of the gift Card transaction.

systemTraceId

 

giftCardResponse

Specifies a Worldpay generated identifier associated with the transaction in our systems. Retain for possible use in reversal transactions.

sequenceNumber

 

giftCardResponse

Specifies a Worldpay generated sequence number associated with the transaction in our systems. Retain for possible use in reversal transactions.

checkoutId

 

token

Specifies a low value token, replacing the CVV value.

sameDayFunding

(attribute)

 

batchRequest

New attribute (boolean) for use by Payment Facilitators using Dynamic Payout and enabled for Same Day Funding. A value of True indicates the desire for same day funding of the funding instructions in the Batch.

orderId

 

acountUpdateResponse

This element, which was removed in V10.0 and above, has been added back to the response message.

sameDayFunding

(attribute)

 

litleOnlineRequest

New attribute (boolean) for use by Payment Facilitators using Dynamic Payout and enabled for Same Day Funding. A value of True indicates the desire for same day funding of the funding instruction.

payFacCredit

fundingSubmerchantId

fundsTransferId

amount

litleOnlineRequest

The parent element for the transaction type that a Payment Facilitator uses to distribute funds to themselves (i.e., from the PayFac Settlement Account to the PayFac Operating Account).

payFacDebit

fundingSubmerchantId

fundsTransferId

amount

litleOnlineRequest

The parent element for the transaction type that a Payment Facilitator uses to move funds from the PayFac Operating Account back to the PayFac Settlement Account.

submerchantCredit

fundingSubmerchantId

submerchantName fundsTransferId

amount

accountInfo

customIdentifier

litleOnlineRequest

The parent element for the transaction type that a Payment Facilitator uses to move funds from the PayFac Settlement Account to the

Sub-merchant Account.

submerchantDebit

fundingSubmerchantId

submerchantName

fundsTransferId

amount

accountInfo

customIdentifier

litleOnlineRequest

The parent element for the transaction type that a Payment Facilitator uses to move funds from the Sub-merchant Account to the PayFac Settlement Account.

reserveCredit

fundingSubmerchantId

fundsTransferId

amount

litleOnlineRequest

The parent element for the transaction type that a Payment Facilitator uses to move funds from the PayFac Settlement Account to the PayFac Reserve Account.

reserveDebit

fundingSubmerchantId

fundsTransferId

amount

litleOnlineRequest

The parent element for the transaction type that a Payment Facilitator uses to move funds from the PayFac Reserve Account to the PayFac Settlement Account.

payFacCreditResponse

litleTxnId fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The parent element for information returned to you in response to a payFacCredit transaction.

payFacDebitResponse

litleTxnId

fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The parent element for information returned to you in response to a payFacDebit transaction.

submerchantCreditResponse

litleTxnId

fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The parent element for information returned to you in response to a submerchantCredit transaction.

submerchantDebitResponse

litleTxnId

fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The parent element for information returned to you in response to a submerchantDebit transaction.

reserveCreditResponse

litleTxnId

fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The parent element for information returned to you in response to a reserveCredit transaction.

reserveDebitRespon se

litleTxnId

fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The parent element for information returned to you in response to a reserveDebit transaction.

physicalCheckCredit

fundingSubmerchantId

fundsTransferId

amount

litleOnlineRequest

The parent element for the transaction type that a Payment Facilitator uses to move funds from the PayFac Settlement Account to a third party that issues physical checks on behalf of the Payment Facilitator.

physicalCheckCreditResponse

litleTxnId

fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The parent element for information returned to you in response to a physicalCheckCredit transaction.

physicalCheckDebit

fundingSubmerchantId

fundsTransferId

amount

litleOnlineRequest

The parent element for the transaction type that a Payment Facilitator uses to move funds from a third party who issues physical checks on the Payment Facilitator’s behalf to the PayFac Settlement Account.

physicalCheckDebitResponse

litleTxnId

fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The parent element for information returned to you in response to a physicalCheckDebit transaction.

vendorCredit

accountInfo

fundingSubmerchantId

fundsTransferId

amount

vendorName

litleOnlineRequest

The parent element for the transaction type that a Payment Facilitator uses to move funds from the PayFac Settlement Account to a Vendor account.

vendorCreditResponse

litleTxnId

fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The parent element for information returned to you in response to a vendorCredit transaction.

vendorDebit

accountInfo

fundingSubmerchantId

fundsTransferId

amount

vendorName

litleOnlineRequest

The parent element for the transaction type that a Payment Facilitator uses to move funds from a Vendor account to the PayFac Settlement Account.

vendorDebitResponse

litleTxnId

fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The parent element for information returned to you in response to a vendorDebit transaction.

fundingInstructionVoid

litleTnxId

litleOnlineRequest

A transaction type that allows you to void an unsettled Dynamic Payout Funding Instruction.

fundingInstructionVoidResponse

litleTxnId

fundsTransferId

response

responseTime

postDate

message

litleOnlineResponse

The response message to a fundingInstructionVoid request.

fastAccessFunding

 

 

fundingSubmerchantId

submerchantName

fundsTransferId

amount

(choice) card, token, or paypage

litleOnlineRequest

 

 

A Dynamic Payout transaction type that allows funds transfer to certain debit cards within 30 minutes.

 

 

fastAccessFundingResponse

 

 

 

 

litleTxnId

fundsTransferId

response

responseTime

postDate

message

tokenResponse (if applicable)

litleOnlineResponse

 

 

 

 

The response message to a fastAccessFunding request.

 

 

 

 

Other schema changes:

  • The max length of the id attribute changed from 25 characters to 36 characters.

  • The version element, a child of applepay changed from 20 characters to 10 characters.

  • Dynamic Payout Funding Instructions, which were Batch only, are now available as Online transactions.

  • New enumerations added to the processingType element to support recurring and installment card on file transactions. The new enumerations are: initialRecurring, and initialInstallment.

  • New enumerations added to the processingType element to support card on file transactions. The new enumerations are: initialCOF, merchantInitiatedCOF, and cardholderInitiatedCOF.